home *** CD-ROM | disk | FTP | other *** search
Text File | 1995-11-25 | 47.8 KB | 1,389 lines |
- ############################################################
- # @(#) Die (neue) Anleitung zu UDO
- # @(#) Copyright (c) 1995 by
- # @(#) Dirk Hagedorn Software
- # @(#) In der Esmecke 9
- # @(#) D-59846 Sundern
- ############################################################
-
- ############################################################
- # Spezielle Sachen
- ############################################################
- !include add\header.ui
-
- !title Die Anleitung zu
-
- !begin_document
-
- # Die Silbenregeln
- !include add\hyphens.ui
-
- !stg_short_toc
- !pch_short_toc
- !asc_no_effects
-
- !maketitle
- !tableofcontents
-
- ############################################################
- # Einleitung
- ############################################################
- !newpage
- !node Einleitung
-
- !stg_subtoc
- !pch_subtoc
-
- #-----------------------------------------------------------
- # Vorwort
- #-----------------------------------------------------------
- !subnode Vorwort
-
- UDO(!N)der Name entspringt von (!B)U(!b)niversal (!B)DO(!b)cument(!n)
- ist ein Programm, wel!-ches Text-Dateien mit speziellen Kommandos
- komplett selbst formatiert, auf Wunsch Titelseite und
- Inhaltsverzeichnis erzeugen kann und dann in folgende
- Formate umwandeln kann:
-
- !begin_enumerate
- !item ASCII
- !item ST-Guide-Quelltext
- !item !LaTeX-Quelltext
- !item Rich Text Format
- !item Pure-C-Help-Quelltext
- !item 1st Wordplus
- !end_enumerate
-
- Die von UDO benutzen Kommandos ähneln sehr stark denen von !LaTeX~und den
- HCP-Kommandos des ST-Guide. Wer also schon einmal mit !TeX~gearbeitet hat
- bzw. einen Hypertext geschrieben hat, der wird sehr schnell mit UDO
- zurechtkommen.
-
- UDO richtet sich an alle Personen, die Anleitungen oder sonstige Texte
- in mehreren Formaten weitergeben möchten. Falls Du eine der folgenden
- Fragen mit ""Ja"" beantworten kannst, dann dürfte UDO genau das
- richtige für Dich sein:
-
- !begin_itemize
- !item Du programmierst und benötigst neben der ASCII-Anleitung noch
- einen Hypertext für den ST-Guide?
- !item Du programmierst und möchtest das Handbuch mit !TeX~oder einer
- Textverarbeitung, die RTF importieren kann, setzen?
- !item Du bist der Autor einer Pure-C-Library und möchtest die
- Beschreibung der einzelnen Routinen neben einer ASCII-Datei
- auch als ST-Guide-Hypertext und als spezielle Hilfedatei im
- PC-Help-Format anbieten?
- !item Du brauchst zwar nur eine ASCII-Anleitung, möchtest aber die
- Kapitel nicht immer manuell durchnumerieren. Außerdem willst Du
- Dir ein Inhaltsverzeichnis automatisch ausgeben lassen können?
- !item Du bist jemand, der öfters an Texten etwas ändert und
- dadurch jedesmal Absätze neu formatieren muß?
- !item Du bist ein Mauser, saugst eh alles und Du mußt eh alles einmal
- ausprobieren? (!grin)
- !end_itemize
-
- Wenn Du keine Frage mit ""Ja"" beantworten konntest, dann dürfte UDO
- nichts für Dich sein und Du kannst Dir das Weiterlesen dieser
- Anleitung sparen.
-
-
-
- #-----------------------------------------------------------
- # UDOs Geschichte
- #-----------------------------------------------------------
- !subnode UDOs Geschichte
-
- Ende 1994 hatte ich ein paar Programme(!N)die Spiele der ""Play it
- again, GEM!""-Reihe(!n) fertiggestellt, die die Unterstützung des
- ST-Guide eingebaut hatten. Für diese Programme benötige ich nun also
- einen Hypertext, eine Anleitung im ASCII-Format sowie eine gedruckte
- Anleitung.
-
- Und schon stand ich vor dem Problem: wie sollte ich die Anleitungen
- erstellen?
-
- !begin_enumerate
- !item Als reine ASCII-Datei, dann die Hypertextkommandos einfügen und
- in Papyrus importieren und neu formatieren?
- !item Als Hypertext und dann die Hypertextkommandos filtern und im
- letzten Schritt wieder in Papyrus importieren und neu formatieren?
- !item Mit Papyrus, dann als ASCII exportieren, neu formatieren, da man
- ja einen Proportionalfont benutzt und der ASCII-Export
- entsprechend scheußlich aussieht und dann wieder im letzten
- Schritt die Hypertextkommandos einfügen?
- !end_enumerate
-
- Ich habe schnell feststellen können, daß das auf Dauer keine Zumutung
- ist und ich mußte mir etwas überlegen. Außerdem hatte ich in der
- Zwischenzeit !TeX~entdeckt; ein neues Format kam auf mich zu. (!grin)
-
- Grübel, grübel und studier; Anfang Januar 1995 war es dann soweit. Ein
- bißchen nachgedacht(!N)ja, wirklich, nicht sofort losgehacked(!n) und
- das erste Ergebnis Dirk Haun präsentiert, der sofort begeistert von
- der Idee war und auch gleich einen Haufen Wünsche hatte und
- Verbesserungsvorschläge machte. UDO war geboren!..
-
- Nun haben wir Ende April und es hat sich gegenüber dem 2. Release einiges
- getan. Wenn ich ""einiges"" sage, dann meine ich das auch. Alleine die
- Tatsache, daß die Historie zu UDO in ein eigenes Dokument ausgelagert
- wurde, spricht schon Bände.
-
-
-
- #-----------------------------------------------------------
- # UDO's Zukunft
- #-----------------------------------------------------------
- !subnode UDO's Zukunft
-
- UDO wird demnächst noch wesentlich mehr können und auch auf anderen
- Rechnersystemen als dem Atari verfügbar sein. Geplant sind unter anderem
-
- !begin_enumerate
- !item eine Umgebung für Tabellen,
- !item die korrekte Ausgabe von 1stWord-Dokumenten,
- !item die Hypertext-Markup-Language (HTML) als Ausgabeformat,
- !item Winhelp-Quelltexte als Ausgabeformat,
- !item Wandlung der Dokumente im RAM,
- !item UDO für Linux(!N)die erste Version wurde bereits compiliert, aber
- noch nicht getestet(!n),
- !item UDO für DOS,
- !item UDO für OS/2,
- !item und wenn sich ein spezieller Herr endlich dazu entschließen würde,
- sich einen ANSI-C-Compiler für seine HP-Apollo zuzulegen, auch ein UDO
- für HP-UX.
- !end_enumerate
-
-
-
- #-----------------------------------------------------------
- # Über diese Anleitung
- #-----------------------------------------------------------
- !subnode Über diese Anleitung
-
- Diese Anleitung wurde vor der Veröffentlichung des Release 3 komplett
- neu geschrieben. Die alte Anleitung war nicht mehr tragbar, da zu
- unübersichtlich.
-
- In dieser Anleitung wird man zum einen etwas über UDO, dem Format erfahren
- sowie etwas über die Bedienung von UDO, dem Programm.
-
- Im folgenden werde ich jeweils ""Abkürzungen"" benutzen. Falls z.B.
- ""für den ST-Guide"" zu lesen ist, dann bedeutet dies soviel wie ""für
- die Wandlung in einen Hypertext-Quelltext für den ST-Guide"". Oder:
- ""bei RTF"" bedeutet dann soviel wie ""bei der Wandlung ins
- RTF-Format"". Ich denke, Ihr werdet schon verstehen, was ich jeweils
- meine.
-
- Ich bitte darum, etwaige Rechtschreibfehler zu entschuldigen und mir
- zu melden, damit ich diese verbessern kann. Nobody's perfect! (!grin)
-
- Falls etwas in dieser Anleitung zu undurchsichtig oder zu kompliziert
- erklärt worden ist, so hilft meist ein Blick in ''(!V)UDO.U(!v)'', dem
- Quelltext dieser Anleitung. Hier sind alle möglichen Befehle
- mindestens einmal benutzt worden.
-
- So wie UDO selbst an !LaTeX~angelehnt ist, so ist auch der Aufbau
- dieser Anleitung an ein Standardwerk für !LaTeX angelehnt. Hierbei
- handelt es sich um ""!LaTeX-Einführung Band 1"" von Helmut Kopka,
- erhältlich im Addison-Wesley-Verlag (ISBN 3-89319-664-1). Jedem, der
- sich ein bißchen für !TeX~interessiert, möchte ich dieses Buch
- besonders ans Herz legen!
-
-
- #-----------------------------------------------------------
- # Bekannte Mängel und Probleme
- #-----------------------------------------------------------
- !subnode Bekannte Mängel und Probleme
-
- !label Mängel
- !label Probleme
-
- !P ist nicht perfekt. Hier eine Auflistung aller derzeit bekannter
- Mängel:
-
- !begin_enumerate
- !item Die 1stWord-Ausgabe ist immer noch etwas daneben. Es fehlen noch
- das Lineal sowie weitere Dinge. Sorry, dazu bin ich in der Eile
- nicht mehr gekommen. Deshalb ist der Button in der GEM-Shell
- auch nicht anwählbar.
- !item Wenn man Freedom als Fileselector benutzt, sollte man
- UDOs Fens!-ter tunlichst nicht verschieben, solange
- Freedom geöffnet ist. Tut man es doch, so wird man mit
- nicht weniger als zwei Re!-draw!-feh!-lern bestraft, sobald
- man Freedom beendet.
- !item Das Iconifying funktioniert in der GEM-Shell nicht unter
- MagiC3. Der Fehler ist bekannt und wird demnächst behoben
- sein.
- !item (hopefully not to be continued!..)
- !end_enumerate
-
-
- Folgende Probleme sind nicht udo-spezifisch, sondern haben eine
- an!-dere Ursache.
-
- !begin_enumerate
- !item Das Problem mit Freedom haben auch andere Programme. (!grin)
- !item Atari Works mag die von UDO erzeugten RTF-Files nicht
- importieren und sagt nur lapidar ""Fehler beim Laden der
- Datei"". Ich tippe darauf, daß Works nicht mit den Zeilenenden
- zurechtkommt, obwohl lauft RTF-Spezifikation ASCII 13
- ignoriert werden muß. Beschwert Euch bei Atari, beim
- Generalvertrieb oder direkt in Indien. (!grin)
- !item Tempus Word soll ebenso Probleme beim RTF-Import haben. Woran
- das liegt, kann ich ohne Tempus Word schlecht beurteilen. UDO
- benutzt nur Befehle, wie sie auch in der RTF-Spezifikation
- an!-ge!-ge!-ben sind. Wenn Tempus Word damit dann nicht
- klarkommt, dann ist das nicht UDO's oder meine
- Schuld, sondern es liegt an der man!-gel!-haf!-ten RTF-Einbindung.
- Beschwert Euch also bitte bei CCD und nicht bei mir.
- !item Papyrus 3.11 unterstützt nicht den RTF-Befehl ''(!V)\line(!v)'',
- weshalb das UDO-Kommando ''(!V)(!/nl)(!v)'' nicht korrekt
- umgesetzt wird.
- !end_enumerate
-
-
-
- ############################################################
- # Shareware
- ############################################################
- !node Shareware
-
- Und schon sind wir beim leidigen Thema angekommen!...
-
- !P ist Shareware und kostet 30~DM inkl. Mehrwertsteuer(!N)dieser Preis ist
- eigentlich ein Witz, wenn man mal bedenkt, was !P alles leistet und was !P
- einem alles an Arbeit erspart(!n).
-
- !P ist in der vorliegenden Kommandozeilenversion nicht ein!-ge!-schränkt.
- Da die Hauptanwendergruppe für !P größtenteils aus Hand!-buch- und
- Programmautoren bestehen dürfte und ich mir hier eine größe!-re
- Zahlungsmoral erhoffe als beim großen Rest der heimlichen
- An!-wen!-der!-schar, habe ich hier auf großartige Einschränkungen und
- Re!-gis!-trie!-rungs!-ver!-fah!-ren verzichtet.
-
- Sollte ich wider Erwarten kaum Resonanz in Form von Registrierungen
- bekommen, werde ich entweder
-
- !begin_enumerate
- !item !P zur Crippleware machen(!N)etwa mit häßlichen Warteschleifen,
- begrenzten Dokumentgrößen, vertauschten Buchstaben in der
- Ziel!-datei, !..(!n) oder
- !item die Weiterentwicklung von !P komplett einstellen oder
- !item neue Versionen nicht mehr veröffentlichen und nur noch an
- re!-gis!-trier!-te Anwender herausgeben.
- !end_enumerate
-
- Das sind keine leeren Drohungen, das ist mein Ernst. Ich bin in der
- Vergangenheit bereits oft genug enttäuscht worden. Manche mögen
- an!-ge!-sichts dieser Worte schmunzeln; ich kann darüber gar nicht mehr
- lachen.
-
- !label Registrierung
-
- Nach erfolgter Registrierung erhält man von mir eine Rechnung, um den Kauf
- von !P steuerlich absetzen zu können, sowie den Schlüssel zur Registrierung
- der eingeschränkten GEM-Shell.
-
- !label Überweisung
- !label V-Scheck
-
- (!B)Und so wird man registrierter Benutzer von !P!..(!b)
-
- Den Shareware-Beitrag von 30~DM(!N)wer mehr spenden will, kann das gerne
- tun (!grin)(!n) kann man mir folgendermaßen zukommen lassen:
-
- !begin_enumerate
- !item Durch Überweisung auf mein Konto. Bitte dabei möglichst die
- komplette Anschrift auf dem Überweisungsträger und ""UDO"" als
- Stich!-wort angeben, damit ich die Überweisung korrekt zuordnen kann.
- Zusätzlich sollte man eine Postkarte oder eine PM per EMail an mich schicken,
- anhand derer man mich informiert, daß man die Überweisung vorgenommen hat.
- !item Durch Zusendung eines Verrechnungsschecks, ausgestellt auf 30~DM.
- !item Durch Zusendung des Geldes per Brief. Am besten ist es, das
- Geld dann per Einschreiben zu verschicken, damit man sicher gehen
- kann, daß das Geld auch mir angekommen ist.
- !end_enumerate
-
-
- !label Autor
- !label Dirk Hagedorn
- !label Bankverbindung
- !label Anschrift
-
- Hier meine Anschrift und meine Bankverbindung:
-
- !begin_quote
- Dirk Hagedorn (!nl)
- In der Esmecke 9 (!nl)
- D-59846 Sundern
-
- Sparkasse Arnsberg-Sundern (!nl)
- Konto 3 561 164 (!nl)
- Bankleitzahl 466 500 05
-
- MausNet: Dirk Hagedorn @ MK2 (!nl)
- !end_quote
-
-
-
- ############################################################
- # TTP
- ############################################################
-
- !newpage
- !include add\udottp.ui
-
-
- ############################################################
- # Grundlagen
- ############################################################
- !newpage
- !node Grundlagen
-
- !stg_subtoc
- !pch_subtoc
-
-
- #-----------------------------------------------------------
- # Grundlagen/Textaufbau
- #-----------------------------------------------------------
- !subnode Textaufbau
-
- !stg_subsubtoc
- !pch_subsubtoc
-
-
- #-----------------------------------------------------------
- # Grundlagen/Textaufbau/Worte, Absätze !& Kapitel
- #-----------------------------------------------------------
- !subsubnode Worte, Absätze !& Kapitel
-
- Ein Text setzt sich aus Worten, Sätzen, Absätzen, Abschnitten und
- Kapiteln zusammen.
-
- Worte bilden Sätze, Sätze bilden Absätze, mehrere Absätze bilden
- Abschnitte und/oder Kapitel.
-
- Ein Wort besteht aus einem oder mehreren Zeichen, von denen keines ein
- Leerzeichen oder ein Tabulator ist. Mehrere Worte bilden einen Satz.
- Zwei Worte werden durch ein oder mehrere Leerzeichen bzw. einen oder
- mehrere Tabulatoren voneinander getrennt.
-
- Ein Absatz besteht aus einem oder mehreren Sätzen. Absätze werden
- durch eine oder mehrere Leerzeile(n) voneinander getrennt.
-
- Ein Abschnitt oder Kapitel besteht aus einem oder mehreren Absätzen.
-
- Ein Wort darf bei UDO maximal 80 Zeichen lang sein. Die Anzahl an
- Worten innerhalb eines Absatzes ist nicht eingeschränkt, ebensowenig
- die Anzahl an Absätzen innerhalb eines Abschnitts oder eines Kapitels.
-
-
- #-----------------------------------------------------------
- # Grundlagen/Textaufbau/Vorspann !& Hauptteil
- #-----------------------------------------------------------
- !subsubnode Vorspann !& Hauptteil
-
- !label Vorspann
- !label Hauptteil
-
- Jeder Text, der von UDO bearbeitet werden soll, muß sich in zwei Teile
- teilen:
-
- !begin_enumerate
-
- !item Vorspann (!nl)
- Im Vorspann können Angaben zum Autor und Inhalt des Textes ge!-macht
- werden, müssen u.U. spezielle Befehle für !LaTeX
- ((!V)\documentstyle(!v), ...), RTF ((!V)!rtf_propfont(!v), ...)
- oder den ST-Guide ((!V)@subject, ...(!v)) eingefügt werden.
-
- !item Hauptteil (!nl)
- Der Hauptteil (!B)muß immer(!b) mit ''(!V)!/begin_document(!v)'' und
- ''(!V)!/end_document(!v)'' geklammert werden und enthält den
- eigentlichen Inhalt der Anleitung.
-
- !end_enumerate
-
-
-
- #-----------------------------------------------------------
- # Grundlagen/Textaufbau/Kommentare
- #-----------------------------------------------------------
- !subsubnode Kommentare
-
- Ein Text darf Kommentare enthalten. Eine Zeile gilt dann als
- Kommentar, wenn das erste Zeichen dieser Zeile ein ''(!V)#(!v)'' ist.
-
- Eine Zeile mit einem Kommentar wird nicht beachtet und ausgegeben.
- Keine Regel ohne Ausnahme: Innerhalb einer Verbatim-Umgebung werden
- auch Kommentare ausgegeben!
-
-
-
-
-
- #-----------------------------------------------------------
- # Grundlagen/Befehle
- #-----------------------------------------------------------
- !subnode Befehle
-
- !label Metazeichen
-
- Innerhalb eines Textes bedarf es spezieller Befehle, anhand derer UDO
- erkennen kann, wie dieser Text zu strukturieren und zu formatieren
- ist. Ein Befehl beginnt jeweils mit ''(!V)!/(!v)'' bzw. mit
- ''(!V)(!/(!v)''.
-
- Da das ''(!V)!/(!v)'' als Metazeichen zu Beginn eines Wortes normalerweise keine
- Verwendung findet, ist die Verwendung unproblematisch. Das
- Metazeichen muß generell nicht (!I)gequotet(!i) werden. Nur dann, wenn man einen
- UDO-Befehl selbst in einem Text verwenden will, so muß man
- das Metazeichen durch ''(!V)!//(!v)'' gequotet werden, wie z.B. dann,
- wenn man das Kommando ''(!V)!//tableofcontents(!v)'' selbst benutzen möchte.
-
-
-
- #-----------------------------------------------------------
- # Grundlagen/Bedingte Befehle
- #-----------------------------------------------------------
- !subnode Bedingte Befehle
-
- Manchmal möchte man spezielle Zeilen nur bei einem Zielformat
- ausgeben. Hierfür existieren folgende Befehle:
-
- ''(!V)!/asc ...(!v)'',
- ''(!V)!/pch ...(!v)'',
- ''(!V)!/rtf ...(!v)'',
- ''(!V)!/stg ...(!v)'',
- ''(!V)!/tex ...(!v)'',
- ''(!V)!/1wp ...(!v)'' und
- ''(!V)!/html ...(!v)''
-
- Trifft UDO am Anfang einer Zeile auf solch einen Befehl, so gibt er
- den Rest der Zeile nur aus, wenn man nach ASCII, PC-Help, RTF,
- ST-Guide, !TeX~ oder 1stWord wandelt.
-
- Durch Verwendung dieser Befehle lassen sich sehr einfach spezielle
- Dinge wie die Grafikeinbindung bei !TeX oder beim ST-Guide oder wie
- das Hinzufügen zusätzlicher spezieller Kommandos lösen.
-
- Im anderen Falle möchte man spezielle Zeilen nicht bei allen
- Ziel!-for!-ma!-ten ausgeben. Hierfür existieren ana!-log folgende Befehle:
-
- ''(!V)!/=asc ...(!v)'',
- ''(!V)!/=pch ...(!v)'',
- ''(!V)!/=rtf ...(!v)'',
- ''(!V)!/=stg ...(!v)'',
- ''(!V)!/=tex ...(!v)'',
- ''(!V)!/=1wp ...(!v)'' und
- ''(!V)!/=html ...(!v)''
-
- Trifft UDO am Anfang einer Zeile auf solch einen Befehl, so gibt er
- den Rest der Zeile immer dann aus, wenn man (!U)nicht(!u) nach ASCII, PC-Help,
- etc. wandelt.
-
- (!B)Vorsicht!(!b) Der Rest der Zeile, der einem bedingten Befehl
- folgt, wird nicht umgewandelt! Das bedeutet, daß man keine
- UDO-Kommandos, UDO-Textstile etc. benutzen kann!
-
-
-
- #-----------------------------------------------------------
- # Grundlagen/Umgebungen
- #-----------------------------------------------------------
- !subnode Umgebungen
-
- UDO verwendet zur Formatierung des Texts genau wie
- !LaTeX~sogenannte
- ""Umgebungen"". Absätze, die innerhalb einer solchen Umgebung stehen,
- werden dabei besonders formatiert.
-
- Eine Umgebung wird durch ''(!V)!begin_...(!v)'' eingeleitet und durch
- ''(!V)!end_...(!v)'' beendet.
-
- Ob eine Umgebung schachtelbar ist und wie die Absätze innerhalb einer
- Umgebung formatiert wird, findet man in den speziellen Kapiteln.
-
-
- #-----------------------------------------------------------
- # Grundlagen/Sonderzeichen
- #-----------------------------------------------------------
- !subnode Sonderzeichen
- Die Zeichen ''(!V)# $ & ~ _ ^ % { } \(!v)'' haben für !TeX~und RTF
- eine spezielle Bedeutung.
-
- Damit bei einem !TeX-Lauf bzw. beim Compilieren des Pure-C-Helpfiles
- keine Fehlermeldungen auftreten, müssen
- diese Sonderzeichen mit Aus!-nahme der Tilde durch
- ''(!V)!/(!v)'' gequotet werden, solange diese Zeichen nicht innerhalb
- einer Verbatim-Umgebung oder zwischen ''(!V)(!/V)...(!/v)(!v)''
- stehen!
-
- Anstelle des Anführungszeichens ''(!V)"(!v)'' sollte man in einem Text
- immer doppelte Anführungszeichen ''(!V)""""(!v)'' benutzen. UDO wandelt
- diese doppelten Anführungszeichen für !TeX~und RTF in die korrekten
- deutschen(!N)ja, ja, immer diese korrekten Deutschen (!grin)(!n)
- Anführungsstriche. Bei allen anderen Formaten werden die doppelten
- wieder durch die einfachen Anführungszeichen ersetzt.
-
- Wer nur für sich selbst Texte im ASCII- und ST-Guide-Format erzeugt,
- braucht die Sonderzeichen nicht zu quoten bzw. doppelte
- An!-füh!-rungs!-zei!-chen benutzen.
-
- Wer allerdings seine Dokumentation auch im UDO-Format weitergeben
- möchte, sollte Sonderzeichen immer quoten und auch immer doppelte
- Anführungszeichen benutzen!
-
-
-
-
- ############################################################
- # Gliederung
- ############################################################
- !newpage
- !node Gliederung
-
- !stg_subtoc
- !pch_subtoc
-
- Jede vernünftige Anleitung läßt sich für gewöhnlich in eine
- Titelseite, ein Inhaltsverzeichnis, Kapitel,
- Abschnitte, Unterabschnitte und einen Anhang
- unterteilen.
-
-
-
-
- #-----------------------------------------------------------
- # Gliederung/Titelseite
- #-----------------------------------------------------------
- !subnode Titelseite
-
- UDO kann durch ''(!V)!/maketitle(!v)'' automatisch eine Titelseite erzeugen.
-
- Dazu müssen im Vorspann die Angaben für ''(!V)!/author(!v)'', ''(!V)!/street(!v)'',
- ''(!V)!/town(!v)'', ''(!V)!/email(!v)'', ''(!V)!/title(!v)'',
- ''(!V)!/program(!v)'', ''(!V)!/version(!v)'' und ''(!V)!/date(!v)''
- ganz oder auch nur teilweise stehen.
-
- Bei der Wandlung ins ST-Guide-Format wird die Titelseite hingegen
- nicht sofort erzeugt, sondern erst bei ''(!V)!/tableofcontents(!v)''.
- Intern wird also lediglich vermerkt, daß der erste Node Titelangaben
- und Inhaltsverzeichnis enthalten soll.
-
-
-
- #-----------------------------------------------------------
- # Gliederung/Inhaltsverzeichnis
- #-----------------------------------------------------------
-
- !subnode Inhaltsverzeichnis
-
- Der Befehl ''(!V)!/tableofcontents(!v)'' wird von UDO durch ein
- automatisch generiertes Inhaltsverzeichnis ersetzt(!N)nicht für
- !TeX~und RTF(!n).
-
- Da dieses Inhaltsverzeichnis durchaus einigen Umfang erhalten kann,
- kann man durch den Befehl ''(!V)_short_toc(!v)'', der irgendwann
- vor ''(!V)!/tableofcontents(!v)'' auftauchen muß, ein kurzes
- Inhaltsverzeichnis ausgeben lassen. Die kürzere Version besteht nur
- noch aus den Kapitelnamen; Abschnitte und Unterabschnitte werden also
- nicht berücksichtigt.
-
- Durch ''(!V)!/short_toc(!v)'' erhält man immer ein kurzes
- Inhaltsverzeichnis. Möchte man jedoch bei der ASCII-Anleitung ein
- langes und beim ST-Guide ein kurzes Inhaltsverzeichnis haben, so muß
- man folgende Befehle anwenden:
-
- ''(!V)!/asc_short_toc(!v)'',
- ''(!V)!/pch_short_toc(!v)'',
- ''(!V)!/stg_short_toc(!v)'' sowie
- ''(!V)!/1wp_short_toc(!v)''
-
- Steht nun im Text z.B. der Befehl ''(!V)!/stg_short_toc(!v)'', so wird
- bei der Wandlung nach ST-Guide ein kurzes Inhaltsverzeichnis
- ausgegeben, bei allen anderen Formaten jeweils ein komplettes
- Inhaltsverzeichnis.
-
- Wenn man nun ein kurzes Inhaltsverzeichnis benutzt, muß man dafür
- sorgen, daß man im Hypertext oder im PC-Helpfile auch zu den
- Abschnitten und Unterabschnitten weiterverzweigen kann.
- Dies ist durch die Befehle ''(!V)!/subtoc(!v)'' und
- ''(!V)!/subsubtoc(!v)'' möglich.
-
- Durch ''(!V)!/subtoc(!v)'' erhält an der aktuellen Position alle zum
- aktuellen Kapitel zugehörigen Abschnitte aufgelistet, durch
- ''(!V)!/subsubtoc(!v)'' ana!-log alle zum aktuellen Abschnitt
- zugehörigen Unterabschnitt.
-
- Möchte man wie im obigen Beispiel nur beim ST-Guide ein
- Unter-Inhaltsverzeichnis, so läßt sich dies durch die Befehle
- ''(!V)!/stg_subtoc(!v)'' und ''(!V)!/stg_subsubtoc(!v)'' lösen.
-
- Für die anderen Formate existieren die Befehle
- ''(!V)!/asc_subtoc(!v)'', ''(!V)!/asc_subsubtoc(!v)'',
- ''(!V)!/pch_subtoc(!v)'', ''(!V)!/pch_subsubtoc(!v)'',
- ''(!V)!/1wp_subtoc(!v)'' und ''(!V)!/1wp_subsubtoc(!v)''
- natürlich auch.
-
-
-
-
- #-----------------------------------------------------------
- # Gliederung/Kapitel, Abschnitte und Unterabschnitte
- #-----------------------------------------------------------
- !subnode Kapitel, Abschnitte und Unterabschnitte
-
- !label Kapitel
- !label Abschnitt
- !label Unterabschnitt
-
- !begin_description
- !item [''(!V)!/node(!v)''] leitet ein Kapitel ein.
- !item [''(!V)!/subnode(!v)''] leitet einen Abschnitt ein.
- !item [''(!V)!/subsubnode(!v)''] leitet einen Unterabschnitt ein.
- !end_description
-
- Alles, was nach diesem Befehl folgt, wird in das Inhaltsverzeichnis
- übernommen. Für !TeX~, RTF, PC-HELP und ST-Guide werden die speziellen
- Befehl bzw. Absatzformate eingefügt.
-
-
-
- #-----------------------------------------------------------
- # Gliederung/Anhang
- #-----------------------------------------------------------
- !subnode Anhang
-
- Der Anhang wird durch den Befehl ''(!V)!/begin_appendix(!v)''
- eingeleitet und mit ''(!V)!/end_appendix(!v)'' beendet.
-
- Kapitel, die innerhalb der Appendix-Umgebung stehen, werden mit
- Großbuchstaben durchnumeriert.
-
- Pro Dokument ist nur ein Anhang möglich!
-
-
- ############################################################
- # Formatierung
- ############################################################
-
- !newpage
- !node Formatierung
-
- !stg_subtoc
- !pch_subtoc
-
- UDO kümmert sich komplett um die Formatierung des Textes. UDO ist es
- völlig egal, wie lang(!N)na ja, nicht ganz, länger als 4092 Zeichen
- darf eine Zeile nicht sein(!n) eine Zeile Deines Quelltextes ist,
- durch wie!-viele Leerzeichen und TABs die Worte eingerückt sind und
- durch wie!-viele Leerzeilen die Absätze voneinander getrennt sind.
-
- UDO bricht Absätze generell auf eine Länge von 70 Zeichen um. Texte
- mit einer Breite von 70 Zeichen lassen sich bequem ausdrucken und auch
- auf in der hohen ST-Auflösung vernünftig lesen. Für !TeX~und RTF
- spielt der Umbruch eh keine Rolle, da hier die Formatierung von
- !TeX~selbst bzw. von der Textverarbeitung übernommen wird.
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Änderungen der Schrift
- #-----------------------------------------------------------
-
- !subnode Änderungen der Schrift
-
- UDO beinhaltet Kommandos zur Änderungen der Schrift bzw. des
- Schriftstils. Diese Kommandos werden bei der Wandlung in ein Format
- entsprechend umgesetzt bzw. gefiltert, falls das Format einen solchen
- Stil nicht kennt.
-
- An Stilen stehen zur Verfügung:
-
- !begin_quote
- !begin_verbatim
- (!B)...(!b) -> bold (fett)
- (!U)...(!u) -> underlined (unterstrichen)
- (!I)...(!i) -> italic (kursiv bzw. schräg)
- (!V)...(!v) -> verb (Schreibmaschinenschrift für TeX, RTF)
- (!F)...(!f) -> fbox (nur für TeX)
- !end_verbatim
- !end_quote
-
-
- Beispiele:
-
- !begin_quote
- (!B)fett(!b)
-
- (!U)unterstrichen(!u)
-
- (!I)kursiv(!i)
-
- (!V)verb(!v)
-
- (!F)fbox(!f)
- !end_quote
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Textverschiebungen
- #-----------------------------------------------------------
- !subnode Textverschiebungen
-
- !stg_subsubtoc
- !pch_subsubtoc
-
- UDO beherrscht momentan nur eingerückten Text. Zentrierter
- Text und Blocksatz folgen demnächst.
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Textverschiebungen/Zentrierter Text
- #-----------------------------------------------------------
- !subsubnode Zentrierter Text
- !label Center-Umgebung
-
- Demnächst!..
-
-
- #-----------------------------------------------------------
- # Formatierung/Textverschiebungen/Eingerückter Text
- #-----------------------------------------------------------
- !subsubnode Eingerückter Text
- !label Quote-Umgebung
-
- Durch die Quote-Umgebung, die durch ''(!V)!/begin_quote(!v)'' und
- ''(!V)!/end_quote(!v)'' gebildet wird, werden Absätze innerhalb dieser
- Umgebung nach rechts eingerückt.
-
- Diese Umgebung ist bis zu viermal schachtelbar. Ein Beispiel:
-
- !begin_quote
- Dies ist ein Satz, der innerhalb der ersten Quote-Umgebung steht.
- !begin_quote
- Dies ist ein Satz, der innerhalb der zweiten Quote-Umgebung steht.
- !begin_quote
- Dies ist ein Satz, der innerhalb der dritten Quote-Umgebung steht.
- !begin_quote
- Dies ist ein Satz, der innerhalb der vierten Quote-Umgebung steht.
-
- Auch dieser Satz steht innerhalb der vierten Quote-Umgebung.
- !end_quote
- Dies ist wieder die dritte Quote-Umgebung.
- !end_quote
- Dies ist wieder die zweite Quote-Umgebung.
- !end_quote
- Dies ist wieder die erste Quote-Umgebung.
- !end_quote
-
- Dieses Beispiel wurde folgendermaßen erzeugt:
-
- !begin_verbatim
- !begin_quote
- Dies ist ein Satz, der innerhalb der ersten Quote-Umgebung steht.
- !begin_quote
- Dies ist ein Satz, der innerhalb der zweiten Quote-Umgebung steht.
- !begin_quote
- Dies ist ein Satz, der innerhalb der dritten Quote-Umgebung steht.
- !begin_quote
- Dies ist ein Satz, der innerhalb der vierten Quote-Umgebung steht.
-
- Auch dieser Satz steht innerhalb der vierten Quote-Umgebung.
- !end_quote
- Dies ist wieder die dritte Quote-Umgebung.
- !end_quote
- Dies ist wieder die zweite Quote-Umgebung.
- !end_quote
- Dies ist wieder die erste Quote-Umgebung.
- !end_quote
- !end_verbatim
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Aufzählungen
- #-----------------------------------------------------------
- !subnode Aufzählungen
-
- !stg_subsubtoc
- !pch_subsubtoc
-
- Für Aufzählungen stehen genau wie in !LaTeX~folgende Umgebungen zur
- Verfügung:
-
- !begin_itemize
- !item ''(!V)!/begin_itemize(!v)'' !.. ''(!V)!/end_itemize(!v)''
- !item ''(!V)!/begin_enumerate(!v)'' !.. ''(!V)!/end_enumerate(!v)''
- !item ''(!V)!/begin_description(!v)'' !.. ''(!V)!/end_description(!v)''
- !end_itemize
-
- Der aufzuzählende Text, der innerhalb dieser Umgebungen steht, wird
- eingerückt und mit einer Markierung versehen. Der aufzuzählende Text
- kann beliebig lang sein. Die einzelnen Aufzählungen werden jeweils
- durch Leerzeilen voneinander getrennt.
-
- Die Umgebungen dürfen bis zu viermal (auch gemischt) geschachtelt werden.
-
- Zur Kennzeichnung einer Aufzählung wird der Befehl ''(!V)!/item ...(!v)''
- benutzt.
-
- Bei der Description-Umgebung kann wahlweise außerdem der
- Befehl ''(!V)!/item [...] ...(!v)'' verwendet werden. Alles, was hier
- in eckigen Klammern steht, wird bei der Aufzählung in Fettschrift
- ausgegeben.
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Aufzählungen/Beispiel 'itemize'
- #-----------------------------------------------------------
- !subsubnode Beispiel ''itemize''
- !label Itemize-Umgebung
-
- !begin_itemize
- !item Die erste Stufe bekommt einen dicken Punkt.
- !begin_itemize
- !item Die zweite Stufe bekommt einen Strich.
- !begin_itemize
- !item Die dritte Stufe bekommt einen Stern.
- !begin_itemize
- !item Die vierte Stufe bekommt einen Punkt ''(!V).(!v)''.
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der vierten Stufe
- korrekt dargestellt.
- !end_itemize
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der dritten Stufe
- korrekt dargestellt.
- !end_itemize
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der zweiten Stufe
- korrekt dargestellt.
- !end_itemize
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der ersten Stufe
- korrekt dargestellt.
-
- !item Leerzeilen zwischen Aufzählungen haben keine Wirkung.
- !end_itemize
-
-
- Dieses Beispiel wurde erzeugt durch:
-
- !begin_verbatim
- !begin_itemize
- !item Die erste Stufe bekommt einen dicken Punkt.
- !begin_itemize
- !item Die zweite Stufe bekommt einen Strich.
- !begin_itemize
- !item Die dritte Stufe bekommt einen Stern.
- !begin_itemize
- !item Die vierte Stufe bekommt einen Punkt ''(!V).(!v)''.
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der vierten Stufe
- korrekt dargestellt.
- !end_itemize
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der dritten Stufe
- korrekt dargestellt.
- !end_itemize
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der zweiten Stufe
- korrekt dargestellt.
- !end_itemize
- !item Selbstverständlich werden Absätze innerhalb
- dieser Umgebung auch in der ersten Stufe
- korrekt dargestellt.
-
- !item Leerzeilen zwischen Aufzählungen haben keine Wirkung.
- !end_itemize
- !end_verbatim
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Aufzählungen/Beispiel 'enumerate'
- #-----------------------------------------------------------
- !subsubnode Beispiel ''enumerate''
- !label Enumerate-Umgebung
-
- !begin_enumerate
- !item Die Numerierung der ersten Stufe erfolgt mit arabischen Ziffern,
- gefolgt von einem Punkt.
- !begin_enumerate
- !item Die Numerierung der zweiten Stufe erfolgt bei UDO in
- Kleinbuchstaben, gefolgt von einer Klammer. !TeX~benutzt
- hier auch Kleinbuchstaben, die allerdings in () gesetzt
- werden.
- !begin_enumerate
- !item Die Numerierung der dritten Stufe erfolgt bei UDO
- mit arabischen Ziffern, gefolgt von einer Klammer.
- !TeX~benutzt hier kleine römische Ziffern, gefolgt
- von einem Punkt.
- !begin_enumerate
- !item Die Numerierung der vierten Stufe erfolgt in
- Großbuchstaben, gefolgt von einem Punkt.
- !item Dies ist auch noch die vierte Stufe.
- !end_enumerate
- !item Dies ist wieder die dritte Stufe.
- !end_enumerate
- !item Dies ist wieder die zweite Stufe.
- !end_enumerate
- !item Dies ist wieder die erste Stufe.
-
- !item Leerzeilen zwischen Aufzählungen haben keine Wirkung.
- !end_enumerate
-
-
- Dieses Beispiel wurde erzeugt durch:
-
- !begin_verbatim
- !begin_enumerate
- !item Die Numerierung der ersten Stufe erfolgt mit arabischen Ziffern,
- gefolgt von einem Punkt.
- !begin_enumerate
- !item Die Numerierung der zweiten Stufe erfolgt bei UDO in
- Kleinbuchstaben, gefolgt von einer Klammer. !TeX~benutzt
- hier auch Kleinbuchstaben, die allerdings in () gesetzt
- werden.
- !begin_enumerate
- !item Die Numerierung der dritten Stufe erfolgt bei UDO
- mit arabischen Ziffern, gefolgt von einer Klammer.
- !TeX~benutzt hier kleine römische Ziffern, gefolgt
- von einem Punkt.
- !begin_enumerate
- !item Die Numerierung der vierten Stufe erfolgt in
- Großbuchstaben, gefolgt von einem Punkt.
- !item Dies ist auch noch die vierte Stufe.
- !end_enumerate
- !item Dies ist wieder die dritte Stufe.
- !end_enumerate
- !item Dies ist wieder die zweite Stufe.
- !end_enumerate
- !item Dies ist wieder die erste Stufe.
-
- !item Leerzeilen zwischen Aufzählungen haben keine Wirkung.
- !end_enumerate
- !end_verbatim
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Aufzählungen/Beispiel 'description'
- #-----------------------------------------------------------
- !subsubnode Beispiel ''description''
- !label Description-Umgebung
-
- Die Description-Umgebung eignet sich besonders für ein Glossar, für
- Danksagungen oder die Erklärung von Funktionsparametern innerhalb
- eines Pure-C-Helpfiles.
-
- An dieser Stelle dient als Beispiel ein wenig Eigenwerbung (!grin):
-
- !begin_description
- !item [Play it again, GEM!] ist eine Reihe von sauberen
- GEM-Spielen, die unter allen TOS-Betriebssystemen, ab 640~x~400
- Punkten mit beliebiger Farbtiefe auch auf Grafikkarten laufen.
- Die Spiele sind erhältlich bei Delta Labs Media und Dirk
- Hagedorn Software.
- !item [Tricky] ist eine GEM-Version von ""Kniffel"", dem bekannten
- und beliebten Würfelspiel. ""Tricky"" ist Shareware und kostet
- nur 15~DM.
- !item [Don't worry, be happy] ist eine GEM-Version des Brettspiels
- ""Mensch ärgere Dich nicht"", ist Shareware und kostet nur
- 15~DM.
- !item [MoveIt] ist eine GEM-Version des Geduldspiels ""Sokoban"",
- bietet 50 Level und kostet nur 10~DM.
- !item [Nanjing] ist eine GEM-Version von ""Huang Shi"" bzw. ""Shih
- Tao"" und kostet nur 15~DM.
-
- !item Auch ein normales ''(!V)!/item(!v)'' ist möglich. Leerzeilen
- bewirken nichts.
- !end_description
-
- Dieses Beispiel wurde erzeugt durch:
-
- !begin_verbatim
- !begin_description
- !item [Play it again, GEM!] ist eine Reihe von sauberen
- GEM-Spielen, die unter allen TOS-Betriebssystemen, ab 640~x~400
- Punkten mit beliebiger Farbtiefe auch auf Grafikkarten laufen.
- Die Spiele sind erhältlich bei Delta Labs Media und Dirk
- Hagedorn Software.
- !item [Tricky] ist eine GEM-Version von ""Kniffel"", dem bekannten
- und beliebten Würfelspiel. ""Tricky"" ist Shareware und kostet
- nur 15~DM.
- !item [Don't worry, be happy] ist eine GEM-Version des Brettspiels
- ""Mensch ärgere Dich nicht"", ist Shareware und kostet nur
- 15~DM.
- !item [MoveIt] ist eine GEM-Version des Geduldspiels ""Sokoban"",
- bietet 50 Level und kostet nur 10~DM.
- !item [Nanjing] ist eine GEM-Version von ""Huang Shi"" bzw. ""Shih
- Tao"" und kostet nur 15~DM.
-
- !item Auch ein normales ''(!V)!/item(!v)'' ist möglich. Leerzeilen
- bewirken nichts.
- !end_description
- !end_verbatim
-
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Ausgabe von Originaltext
- #-----------------------------------------------------------
- !subnode Ausgabe von Originaltext
- !label Verbatim-Umgebung
-
- Manchmal möchte man Textabschnitte so ausgeben, wie sie im Text ste!-hen.
- Ein Beispiel ist z.B. ein Teil eines Sourcecodes eines Programms.
-
- Für diesen Zweck gibt es in UDO wie auch in !TeX~die
- Verbatim-Umgebung, welche durch die Befehle
- ''(!V)!/begin_verbatim(!v)'' und ''(!V)!/end_verbatim(!v)''
- gekennzeichnet wird.
-
- Alles, was zwischen diesen beiden Befehlen steht, wird ohne
- Be!-ar!-bei!-tung und ohne Formatierung, also 1:1 ausgegeben.
- Einrückungen der Quote-Umgebung werden jedoch berücksichtigt.
-
-
- #-----------------------------------------------------------
- # Formatierung/Silbentrennung
- #-----------------------------------------------------------
- !subnode Silbentrennung
-
- Man kann von UDO nicht erwarten, daß er eine komplette Sil!-ben!-tren!-nung, wie
- man sie von !TeX~oder einer Textverarbeitung her kennt, beinhaltet.
- Allerdings kann man UDO die Silben eines Wortes durch den Trennstrich
- ''(!V)!/-(!v)'' kenntlich machen.
-
- Da Bilder bekanntlich mehr als tausend Worte sagen, hier ein kleines
- Beispiel, in dem extralange Wortkonstrukte als Verdeutlichung dienen:
-
- Dies ist das erste Beispiel:
- Ein
- Fußballstadionflutlichtglühbirnenfassungsgewinde
- und noch ein
- Fußballstadionflutlichtglühbirnenfassungsgewinde
- sind zusammen zwei
- Fußballstadionflutlichtglühbirnenfassungsgewinde.
-
- Dies ist das zweite Beispiel:
- Ein
- Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir!-nen!-fas!-sungs!-ge!-win!-de
- und noch ein
- Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir!-nen!-fas!-sungs!-ge!-win!-de
- sind zusammen zwei
- Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir!-nen!-fas!-sungs!-ge!-win!-de.
-
- Und so sieht das im Quelltext aus:
-
- !begin_quote
- !begin_verbatim
- Dies ist das erste Beispiel:
- Ein
- Fußballstadionflutlichtglühbirnenfassungsgewinde
- und noch ein
- Fußballstadionflutlichtglühbirnenfassungsgewinde
- sind zusammen zwei
- Fußballstadionflutlichtglühbirnenfassungsgewinde.
-
- Dies ist das zweite Beispiel:
- Ein
- Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir...
- und noch ein
- Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir...
- sind zusammen zwei
- Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir...
- !end_verbatim
- !end_quote
-
-
- Beim ersten Beispiel sieht man gleich, daß das sinnlose Wort den ganzen
- Umbruch zerstört und eine absolut häßliche Ausgabe erzeugt. Das zweite
- Beispiel hingegen sieht doch ganz brauchbar aus, oder? (!grin)
-
- Jetzt stellen wir uns einmal vor, wir hätten wirklich solch ein
- Wort!-un!-ge!-tüm in einem unserer Quelltexte. Die dauernde erneute Angabe der
- Trennstriche ginge einem sicher schnell auf die Nerven. Aber es gibt
- Abhilfe.
-
- Durch das Kommando ''(!V)!/hyphen(!v)'' kann man UDO sagen, daß er
- gefälligst ein bestimmtes Wort immer(!N)genauer, ab dem Auftreten von
- ''(!V)!/hyphen(!v)''(!n) auf eine bestimmte Art und Weise zu trennen hat.
-
- Im obigen Beispiel hätte also das Einfügen des Kommandos
-
- !begin_quote
- !begin_verbatim
- !hyphen Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir...
- !end_verbatim
- !end_quote
-
- dieselbe Wirkung erzielt. Probieren wir es doch einmal kurz aus:
-
- !hyphen Fuß!-ball!-sta!-dion!-flut!-licht!-glüh!-bir!-nen!-fas!-sungs!-ge!-win!-de
-
- Dies ist das erste Beispiel:
- Ein
- Fußballstadionflutlichtglühbirnenfassungsgewinde
- und noch ein
- Fußballstadionflutlichtglühbirnenfassungsgewinde
- sind zusammen zwei
- Fußballstadionflutlichtglühbirnenfassungsgewinde.
-
-
- (!B)Wichtige Anmerkungen(!b):
-
- Der (!V)!/hyphen(!v)--Befehl ist nicht ganz unproblematisch und kann einem
- schnell einen ganzen Zieltext unbrauchbar machen:
-
- UDO speichert die mit ''(!V)!/hyphen(!v)'' gemachten Trennvorschläge in
- einer in!-ter!-nen Liste, welche Platz für 256 Einträge zu je 80 Zeichen
- bie!-tet, und arbeitet diese nach dem FIFO--Prinzip ab(!N)FIFO bedeutet
- ""first in first out""(!n).
-
- Bei der Ausgabe eines Wortes schaut UDO dann in der internen Liste nach, ob
- ein Trennvorschlags-Muster in diesem Wort vorkommt. Falls ja, so wird
- dieses Muster in dem Wort eingesetzt.
-
- Bei der Verwendung der Trennvorschläge ist folgendes zu beachten:
-
- !begin_description
- !item [Plural vor Singular]: ''(!V)For!/-ma!-/te(!v)'' vor
- ''(!V)For!/-mat(!v)''. UDO würde im um!-ge!-kehr!-ten Falle aus
- ''(!V)Formate(!v)'' das Wort ''(!V)For!/-mate(!v)'' erzeugen und
- würde die letzte Silbe nicht mehr bei der Trennung berücksichtigen.
- !item [Groß/Kleinschreibung beachten]: ''(!V)Sei!/-te(!v)'' ist nicht
- gleich ''(!V)sei!/-te(!v)''.
- !item [Sparsamer Einsatz]: Jeder zusätzliche Trennvorschlag verlangsamt
- die Konvertierung. ''(!V)!/hyphen(!v)'' sollte also nur bei Wörtern
- benutzt werden, die mindestens viermal oder öfters im Quelltext
- auf!-tre!-ten. Ansonsten benutzt man besser direkt im Quelltext die
- Trennstriche.
- !item [Rechtzeitiger Einsatz]: Ein Trennvorschlag wir bei der
- Konvertierung erst ab der Stelle beachtet, bei dem er angegeben
- wurde. Trenn!-vor!-schlä!-ge setzte man daher am besten an den Anfang des
- Quelltextes bzw. lagert sie in eine eigene Datei aus und bindet
- diese per ''(!V)!/include(!v)'' gleich am Anfang des Quelltextes
- ein.
- !end_description
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Zeilenumbruch
- #-----------------------------------------------------------
- !subnode Zeilenumbruch
-
- UDO formatiert den Text eigenständig und trennt Absätze durch
- Leerzeilen. Man hätte also keine Möglichkeit, einen Zeilenumbruch zu
- er!-zwin!-gen, würde es nicht den Befehl ''(!V)(!/nl)(!v)'' geben.
-
- Durch ''(!V)(!/nl)(!v)'' erhält man also die Möglichkeit,
- einen Absatz an beliebiger (!nl) Stelle aufzubrechen.
-
- Obiges Beispiel wurde erzeugt durch:
-
- !begin_verbatim
- Durch ''(!V)(!/nl)(!v)'' erhält man also die Möglichkeit,
- einen Absatz an beliebiger (!nl) Stelle aufzubrechen.
- !end_verbatim
-
-
- Ein weiteres Einsatzgebiet ist z.B. der erzwungene Zeilenumbruch bei
- den Itemize-Umgebung:
-
- !begin_itemize
- !item Hier steht Blödsinn (!nl) Hier auch.
- !item Und hier erst (!nl)
- Besser wird's nicht...
- !end_itemize
-
-
- Dieses Beispiel wiederum wurde folgendermaßen erzeugt:
-
- !begin_verbatim
- !begin_itemize
- !item Hier steht Blödsinn (!nl) Hier auch.
- !item Und hier erst (!nl)
- Besser wird's nicht...
- !end_itemize
- !end_verbatim
-
-
-
- #-----------------------------------------------------------
- # Formatierung/Seitenumbruch
- #-----------------------------------------------------------
- !subnode Seitenumbruch
-
- Durch den Befehl ''(!V)!/newpage(!v)'' kann man !TeX~und RTF dazu
- zwingen, den folgenden Text auf eine neue Seite zu positionieren.
-
- Bei der Wandlung nach 1stWord wird ''(!V)!/newpage(!v)'' durch einen
- Formfeed (ASCII 12) ersetzt.
-
- Bei allen anderen Zielformaten wird ''(!V)!/newpage(!v)'' gefiltert.
-
-
- ############################################################
- # Grafikeinbindung
- ############################################################
- !newpage
- !node Grafikeinbindung
-
- !stg_subtoc
- !pch_subtoc
-
- !P kann die Einbindung von GEM-Images für den ST-Guide, das CS-!TeX
- und das Lindner-!TeX umsetzen. Das Bild wird dabei jeweils zentriert
- und mit der (optionalen) Bildunterschrift versehen.
-
- Für die Einbindung sorgt ''(!V)!/image F [B](!v)''. ''F'' ist dabei der
- Dateiname des GEM-Images, ''B'' die optionale Bildunterschrift.
-
- Hier ein Beispiel:
-
- !tex_lindner
- !tex_dpi 100
- !image img\tiger.img Ein GEM-Image
-
- Dieses Beispiel wurde erzeugt mit!..
-
- !begin_quote
- !begin_verbatim
- !tex_lindner
- !tex_dpi 100
- !image img\tiger.img Ein GEM-Image
- !end_verbatim
- !end_quote
-
-
- #-----------------------------------------------------------
- # Grafikeinbindung/ST-Guide
- #-----------------------------------------------------------
- !subnode Grafikeinbindung für den ST-Guide
-
- !P ermittelt zunächst die Breite und Höhe des Bildes, gibt eine
- ''(!V)@image(!v)''-Zeile so aus, daß das Bild zentriert dargestellt
- wird und fügt dann noch in der erzeugten STG-Datei die nötige Anzahl
- an Leerzeilen ein.
-
- Die Zentrierung des Bildes und die Anzahl der Leerzeilen beziehen sich
- dabei auf die Ausmaße des 10pt-Systemfonts.
-
- Wurde eine Bildunterschrift angegeben, so wird diese ebenfalls
- zen!-triert direkt unterhalb des Bildes ausgegeben.
-
-
- #-----------------------------------------------------------
- # Grafikeinbindung/Lindner-TeX
- #-----------------------------------------------------------
- !subnode Grafikeinbindung für das Lindner-!TeX
-
- Damit !P weiß, daß die Grafikeinbindung für das CS-!TeX erzeugt wer!-den
- soll, muß man im Quelltext ''(!V)!/tex_lindner(!v)'' angeben. Außerdem
- muß im Vorspann des Quelltextes
-
- !begin_quote
- !begin_verbatim
- !tex \input graphic
- !end_verbatim
- !end_quote
-
- eingefügt wer!-den.
-
- Dem Lindner-!TeX liegt ein Utility namens ''IMGTOTEX'' bei, mit dem
- man die Auflösung eines Bildes ändern und eine dem Bild zugehöriges
- Makro zur Einbindung erzeugen kann. ''IMGTOTEX'' wird für !P nicht
- mehr benötigt, denn !P übernimmt vollständig seine Funktion.
-
- Durch den Befehl ''(!V)!/tex_dpi XXX(!v)'' bestimmt man die Auflösung
- der fol!-gen!-den Bilder. !P liest zunächst den Header des Images aus,
- über!-prüft dessen Auflösung und schreibt -- falls nötig -- die neue
- Auf!-lö!-sung in den Header. Defaultmäßig steht die Auflösung auf 100dpi.
- Sie kann vor jedem Bild neu gesetzt werden.
-
- Zur eigentlichen Einbindung wird dann ein passendes Makro für das
- Lindner-!TeX geschrieben, das Ganze in eine Figure-Umgebung gepackt
- und falls eine Bildunterschrift angegeben wurde, diese als
- ''(!V)\caption(!v)'' in die Figure-Umgebung gesetzt.
-
-
-
- #-----------------------------------------------------------
- # Grafikeinbindung/CS-TeX
- #-----------------------------------------------------------
- !subnode Grafikeinbindung für das CS-!TeX
-
- Damit !P weiß, daß die Grafikeinbindung für das CS-!TeX erzeugt wer!-den
- soll, muß man im Quelltext ''(!V)!/tex_strunk(!v)'' angeben.
-
- Genau wie beim Lindner-!TeX wird zur Einbindung des Images ein
- pas!-sen!-des Makro geschrieben, das Ganze in eine Figure-Umgebung
- ge!-packt
- und falls eine Bildunterschrift angegeben wurde, diese als
- ''(!V)\caption(!v)'' in die Figure-Umgebung gesetzt.
-
- Auch beim Strunk-!TeX wird auf die mittels ''(!V)!/tex_dpi(!v)''
- gesetzte Auf!-lö!-sung zurückgegriffen.
-
- Da ich mich dem Strunk-!TeX allerdings nicht gut auskenne, kann es
- sein, daß die Bildeinbindung nicht gut gelöst ist. Wenn Du mir einen
- Tip geben kannst, wie man es besser machen sollte, dann her damit!
-
-
-
- ############################################################
- # Tips & Tricks
- ############################################################
-
- !newpage
- !node Tips !& Tricks
-
- !stg_subtoc
- !pch_subtoc
-
- Diese Kapitel sind noch vorläufig und werden denächst überarbeitet. Sobald
- die ersten Fragen auftauchen, werde ich dann auch genau wis!-sen, was besser
- und genauer erklärt werden muß.
-
- !include add\udo2tex.ui
-
- !include add\udo2pch.ui
-
-
-
-
-
- ############################################################
- # Anhang
- ############################################################
-
- !begin_appendix
-
- !newpage
- !include add\bezug.ui
-
- !newpage
- !include add\thanx.ui
-
- !newpage
- !include add\recht.ui
-
- !end_appendix
-
-
- ############################################################
- # Feierabend
- ############################################################
- !end_document
-
-